home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-04 / unity320.zip / UINST.DOC < prev    next >
Text File  |  1991-05-01  |  11KB  |  233 lines
  1.  
  2.         Customizing Unity Programmer's Editor Version 3.0
  3.  
  4. An abundance of features of Unity can be customized either from
  5. inside of the editor or with the installation program.
  6.  
  7. The features that require the installation program to be modified
  8. are the keyboard and programming tool configuration.  All other
  9. configurable options can be modified and saved from within the
  10. editor itself.
  11.  
  12. COMPILER CUSTOMIZATION
  13. ======================
  14. When you first run the installation program you will be presented
  15. with a data entry screen that allows you to install virtually any
  16. type of programming tool.  The first four have been installed for
  17. you (Turbo Pascal, Turbo Assembler, Turbo Debug, and Turbo
  18. Profiler), this leaves six additional slots available for tools
  19. of your choice.
  20.  
  21. The Tools installation screen looks somewhat like this:
  22.  
  23. === Tool 1 ===================================================================
  24.  
  25.   Menu name:
  26.  
  27.   Program name:
  28.  
  29.   Primary extension:                    Alternate extension:
  30.  
  31.   Command line:
  32.  
  33.   Compiler?                Run project?                  Pause?
  34.  
  35.   Run filter:              Prompt?
  36.  
  37.   Error filter:
  38.  
  39.   Filter command line:
  40.  
  41. ============================================================================
  42.  
  43. The state of the COMPILER? field causes certain other fields to be unused.
  44. When a tool is a compiler type the RUN_PROJECT and PAUSE fields are not
  45. used.  When a tool is not a compiler type the fields RUN_FILTER,
  46. ERROR_FILTER, AND FILTER_COMMAND_LINE are not used.  When a field is not
  47. used you will not be able to access it and the screen attribute of the
  48. field will be of reduced intensity.
  49.  
  50. Explanation of fields:
  51. ======================
  52.  
  53. Menu name - This is the string that will be displayed on the
  54.         pulldown menu.  The first capital letter will be the
  55.         menu's hotkey.  When the menu is displayed pressing a
  56.         letter that corresponds to a menu hotkey will result in
  57.         the command being executed.  You can also configure a key
  58.         that will execute the command without the need of
  59.         accessing the menu (see the section on keyboard
  60.         customization).
  61.  
  62. Program name - This is the name and extension of the program that
  63.         will be executed.  If the specified program is not in the
  64.         current directory or on the PATH you must specify the
  65.         drive and path along with the program name.
  66.  
  67. Command line - This is the command line you wish to pass to the
  68.         tool.  You must include a % variable to indicate the
  69.         position of the file name on the command line.  Refer to
  70.         the manual or UNITY.DOC for a list of % variables that
  71.         are supported. This option can also be modified from
  72.         within the editor.
  73.  
  74. Primary & Alternate extensions -  Extensions must be given if you
  75.         wish automatic compiler selection when you execute the
  76.         PROJECT command.  If Unity does not find a particular
  77.         extension when you execute Project the first tool will be
  78.         executed by default. The extensions are ignored if you
  79.         specify a specific tool to execute.
  80.  
  81. Compiler? - You must specify whether the tool is a compiler type
  82.         (includes compilers, assemblers, and linkers) or some
  83.         other type of programming tool.  Unity executes compiler
  84.         types differently than other tools, specifically, the
  85.         standard output is redirected to a file so that error
  86.         messages can be parsed with the filter program.
  87.  
  88. Run Project? - This field allows three settings, "No", "Yes", or
  89.         "Ask".  If set to "No" the tool will be executed without
  90.         checking if the file (current or primary) is out of date.
  91.         Setting it to yes will cause the file to be recompiled
  92.         before running the tool.  Setting it to "Ask" will result
  93.         in you being asked if it should be recompiled when it is
  94.         out of date.  When you are asked, you can recompile by
  95.         answering yes, go right to running the tool with a no
  96.         answer, or cancel the entire operation by pressing ESC.
  97.         Tools that are defined as compiler types force this field
  98.         to "No" since any other response could result in an
  99.         infinite loop condition.
  100.  
  101. Run Filter - If the compiler always returns a nonzero exit code
  102.         when an error is found set this option to "On Error".
  103.         Turbo Pascal is this type.  When a 0 exit code is
  104.         returned Unity knows that it doesn't need to look for
  105.         errors in the redirected output file.  However, Turbo
  106.         Assembler returns an exit code of 0 if only warning
  107.         errors are found so Unity must scan the output file for
  108.         error messages so the setting should be "Always". Setting
  109.         this option to "Always" when a "On Error" is allowed will
  110.         not cause any problems, it will just take longer for
  111.         Unity to finish processing the file. Setting it to "On
  112.         Error" when it should be "Always" can result in Unity not
  113.         detecting certain types of errors with some compilers or
  114.         assemblers.  This field is forced to "Never" for
  115.         non-compiler type tools and should should be set to
  116.         "Never" for tools that return error messages in the
  117.         format expected by Unity.
  118.  
  119. Prompt - If set to YES you will have the opportunity to modify
  120.         the command line passed to the program before it is
  121.         executed.  If set to NO the only way to change the
  122.         command line is through the menu (Program Options) or
  123.         when you install the tool.  Any changes you make to the
  124.         command line will be retained until you exit the editor.
  125.         This field is ignored when processing a project file.
  126.  
  127. Filter - This is the name of the program that scans the output of
  128.         the compiler for error messages.  FERROR.EXE is included
  129.         in this package and handles a number of different
  130.         compilers and assemblers.  This field is ignored by
  131.         non-compiler type tools.
  132.  
  133. Filter Command Line:  This is the command line passed to the
  134.         filter program.  You must specify the position of the
  135.         file name with a % variable.  Normally this should be %1,
  136.         pass the path, name and extension of the error file to
  137.         the filter.  The %2 variable indicates where to place the
  138.         name of the program that was compiled.  Most filters will
  139.         not need this as the error messages will already include
  140.         the file name.  You can also include command line switches
  141.         and other information if your filter program needs it.
  142.  
  143.  
  144. Press <PgUp> and <PgDn> to change the tool number you are
  145. modifying.
  146.  
  147. Pressing <Esc> terminates compiler installation and moves on to
  148. keyboard installation.
  149.  
  150.  
  151. AUTOMATIC TOOL CONFIGURATION
  152. ============================
  153. Instead of manually entering the information for each tool you
  154. can load preconfigured tools by pressing F2.  A description of
  155. tools available will be diplayed in a window for you to select
  156. from.  Use the up and down arrows to scroll through the list,
  157. prss <RETURN> to select the highlighted tool, press ESC to cancel
  158. the selection.  After selecting a tool configuration you can
  159. still edit it for your personal requirements.
  160.  
  161. Pressing F3 allows you to save a tools configuration.  After
  162. pressing F3 the tool list window will be displayed.  Select the
  163. tool you wish to overwrite with the new configuration or <add as
  164. new tool> to create a new configuration choice.  Pressing ESC
  165. cancels the operation.  If you select the NEW option you will be
  166. asked to enter a description (up to 25 characters) which is to be
  167. used in the selection window.  Pressing ESC or not entering a
  168. description will cancel the operation.
  169.  
  170. The file 'UNITY.ACG' must be in the current directory, somewhere
  171. on the path, or in the same subdirectory that UINST.EXE resides in
  172. (DOS 3.x and higher, only).  This file contains the automatic
  173. installation information, without it you must manually enter all
  174. tool information.
  175.  
  176. KEYBOARD CUSTOMIZATION
  177. ======================
  178. The top line of the screen will show the name of the program
  179. being installed (UNITY.EXE) followed by some basic instructions
  180. below it. The remainder of the screen shows (from left to right)
  181. the name of the commmand, the primary key sequence, and the
  182. secondary key sequence.
  183.  
  184. Move the cursor to thekey sequence you want to changve and press
  185. <Enter>.  Use the left arrow and right arrow keys to select
  186. primary or secondary key sequences, and scroll through the list
  187. of commands using the up arrow, down arrow, PgUp, and PgDn keys.
  188. Home takes you to the first commadn, and End to the last.
  189.  
  190. You can correct mistakes in the current entry by pressing the
  191. Backspace key (delete last keystroke), C (clear entry), or R
  192. (restore previous entry).  To specify either the <Enter> or a
  193. <CtrlM>, you must first pres the Scroll Lock key, which indicates
  194. that that keystrokes are to be interpreted literally; press it
  195. again when you have finished entering the key sequence.
  196.  
  197. WARNING!  The Abort command MUST be assigned to a single byte
  198. keystroke.  Nearly all Ctrl keystrokes are a single byte, while
  199. all Alt keystrokes require two bytes and will not work.  While
  200. many commands use two single byte keystrokes, Abort will not
  201. function properly if you assign a two keystrokes.
  202.  
  203. When you have finished makeing chages, press <Esc> followed by
  204. 'Q' to quit (without saving the changes) or 'M' to save the changes
  205. by modifying UNITY.EXE, or 'C' to create a configuration file.
  206. If you choose save your changes you will then see the message
  207. "Checking for conflicts...."  If you have accidentally assigned
  208. the same key sequence to two different commands, and error
  209. message will be displayed.  You can correct your mistakes by
  210. searching for highlighted items.
  211.  
  212. You will also see an error message if the new list of keystrokes
  213. is too large to fit in the are set aside for it.  You can easily
  214. solve this problem by eliminating a few secondary key sequences.
  215.  
  216. After checking for conflichts you will be asked if you wish a
  217. keyboard quick reference guide.  If you answer yes ('Y') the file
  218. UNITY.KEY will be created in the current subdirectory.  This is a
  219. list of all the commands and their associated primary and
  220. secondary key sequences.
  221.  
  222. CUSTOMIZING OTHER OPTIONS
  223. =========================
  224. Features that can be customized and saved from within the editor
  225. include (but are not limited to):
  226.  
  227.      Margins
  228.      Tool options
  229.      Snow control and screen colors
  230.      Tab settings
  231.      Format options
  232.      Swapping (EMS, XMS, and disk)
  233.